﻿Copyright (c) 2008-2018, RF-Embedded GmbH
All rights reserved.
 
Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, 
    this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright notice, 
    this list of conditions and the following disclaimer in the 
    documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 

This software SDK is a example implementation for the RF-Embedded Reader-Host-Protocol. 
The SDK is provided as open source and follows the license terms of above.

The provide protocol handler consists of the following files:
	
	com.rfe.protocol.JrfeProtocolHandler
			The implementation of the protocol handler. This class represents all functions of the 
			Reader-Host-Protocol in separate methods.

	com.rfe.protocol.JrfePURprotocolHandler
			The implementation of the PUR protocol handler. This class extends the CSrfeProtocolHandler

	com.rfe.protocol.JrfeAURprotocolHandler
			The implementation of the AUR protocol handler. This class extends the CSrfeProtocolHandler

	com.rfe.protocol.JrfeTagEvent
			The class contains all data from a tag event.
			
	com.rfe.protocol.JrfeMessageQueue
			Used by the protocol handler to store incomming messages.
			
	com.rfe.protocol.JrfeConstants
			The class contains all constants defined in the protocol description.

	com.rfe.protocol.JrfeProtocolException
			The class contains a custom exception implementation used by the protocol handler.
			
	com.rfe.trace.ITraceInterface
			Abstract class of a trace class. Subclass this class to implement custom tracing.
			
	com.rfe.device.IProtcolDeviceInterface
			Minimal interface that must be implemented by an IODevice that communicates with the 
			reader. This can be a serial port, TCP client, ...
			Just subclass this interface to create the custom communication.

	com.rfe.helper.JrfeHelper
			Class containing static helper functions. 
			
	com.rfe.JrfeGlobal
			Global class with global variables and easy access to trace capability.
			

For test of the provided protocol handler the following files are attached:	

	com.rfe.test.impl.ConsoleTrace
			Simple implementation of the ITraceInterface. Traces everything out to the Console.

	com.rfe.test.impl.TCPDevice
			Simple implementation of the IProtcolDeviceInterface. Implements the communication 
			with a TCP port.

	com.rfe.test.TestProgram
			Test class containing all implemented tests

	com.rfe.test.TestProgramExtended
			Extends the TestProgram class. Offers possibility to 
			- Automatically open a reader device
			- Automatically chose the reader type
			- Add an own test implementation
			
	com.rfe.test.MainProgram
			Main class containing the Main routine which calls the test programs.